Skip to content

FastMCP implementation - #4

Merged
wayzeek merged 3 commits into
mainfrom
fastmcp-implementation
Apr 1, 2025
Merged

FastMCP implementation#4
wayzeek merged 3 commits into
mainfrom
fastmcp-implementation

Conversation

@wayzeek

@wayzeek wayzeek commented Apr 1, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation

    • Enhanced README with updated usage instructions, detailed examples for custom tools, resources, and prompts, and a reference link for FastMCP.
    • Updated server initialization commands and transport options (stdio and SSE).
  • New Features

    • Simplified server setup with dynamic configuration and integrated transport settings.
  • Refactor

    • Transitioned the entire server framework to FastMCP, updating dependencies and streamlining prompt, resource, and tool registration.

@coderabbitai

coderabbitai Bot commented Apr 1, 2025

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request refactors the MCP server project by integrating the FastMCP framework. Documentation in the README has been updated to reflect new command names, detailed usage instructions, and examples for custom tools, resources, and prompts. Across various source files, method signatures and API calls have been updated to replace the old McpServer with FastMCP, and dependency references have been changed accordingly. The HTTP server implementation has been streamlined by removing the Express middleware and routing in favor of a simpler, asynchronous startup process that directly configures the transport type.

Changes

File(s) Change Summary
README.md Updated documentation with enhanced descriptions, rebranding (from @mcpdotdirect/create-mcp-server to @mcpdotdirect/mcp-server), detailed usage for stdio and SSE transports, and links to the FastMCP GitHub repository.
bin/create-mcp-server.js, package.json Dependency changes: Removed dependency on @modelcontextprotocol/sdk (v^1.7.0) and added fastmcp (v^1.21.0); updated command references to reflect the new package name.
src/core/prompts.ts,
src/core/resources.ts,
src/core/tools.ts
Updated function signatures to accept FastMCP instead of McpServer and replaced legacy registration methods (e.g., prompt, resource, tool) with new FastMCP methods (addPrompt, addResourceTemplate, addTool) using structured configuration objects.
src/index.ts Simplified the server initialization process by removing the explicit use of StdioServerTransport and directly starting the FastMCP server with a configuration object specifying the transport type (stdio).
src/server/http-server.ts,
src/server/server.ts
Refactored the HTTP server setup: Removed Express-related middleware and routing, replaced the old server instantiation using McpServer with FastMCP, and introduced an asynchronous main function to handle server startup and dynamic port configuration for SSE.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant S as FastMCP Server
    participant T as Transport Layer
    U->>S: Initialize server with config (stdio/HTTP)
    S->>T: Setup transport based on configuration
    T-->>S: Transport is ready
    S-->>U: Server operational
Loading
sequenceDiagram
    participant Dev as Developer
    participant S as FastMCP Server
    participant P as Prompt Registry
    participant R as Resource Registry
    participant T as Tool Registry
    
    Dev->>S: registerPrompts({ name, description, load })
    S-->>Dev: Prompt registered
    
    Dev->>S: registerResources({ uriTemplate, name, load })
    S-->>Dev: Resource registered
    
    Dev->>S: registerTools({ tool details via z.object })
    S-->>Dev: Tool registered
Loading

Poem

I'm a rabbit with a skip and a hop,
Celebrating changes that make our code pop!
FastMCP now leads the way,
With cleaner tools to brighten our day.
Leaping through prompts and routes, oh joy!
Hop on—our server's a shiny new toy!
🥕🐇 Happy code and bunny cheer!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3ac7f52 and fc035eb.

📒 Files selected for processing (9)
  • README.md (3 hunks)
  • bin/create-mcp-server.js (1 hunks)
  • package.json (1 hunks)
  • src/core/prompts.ts (1 hunks)
  • src/core/resources.ts (1 hunks)
  • src/core/tools.ts (1 hunks)
  • src/index.ts (1 hunks)
  • src/server/http-server.ts (1 hunks)
  • src/server/server.ts (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@wayzeek
wayzeek merged commit 4850e79 into main Apr 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant